GET a Specific Client

Returns a singular client with given Unique ID. The ID here is the Unique GUID for client resources. This will return all client fields (fixed, dynamic and MVFields), addresses, address fields, phone fields . By default, the response includes expanded nested resources. This includes client resource object , address resource object, phones resource object.

Resource/Request URI

http://server:port/PASService/rest/services/clients/{id}

Method

GET

Sample JSON Response

{
"client": {
"clientId": "5012334343",
"type": "Individual",
"firstName": "Johny",
"lastName": "Mason",
"taxId": "1265118",
"updatedDate": ""2017-07-17T19:04:49Z",
"legalResidenceCountryCode": "SG",
"entityType": "Client",
"status": "Active",
"agentCode": "AG898989",
"applicationType": "Normal",
"bankAccount": "7878787",
"Links": [{
"rel": "self",
"href": "https://www.someuri.com/v1/rest/clients/50123343435012334343"
},
{
"rel": "self",
"href": "https://www.someuri.com/v1/rest/clients/50123343435012334343"
},
{
"rel": "phones",
"href": "https://www.someuri.com/v1/rest/clients/50123343435012334343/phones"
}
],
"addresses": [{
"addressId": "66457304DF3640 A4AF80D319B42741C5",
"addressLine1 ": "123 Main St",
"addressLine2": "Kingsway",
"addressLine3": "more street",
"addressLine4": null,
"addressLine5": null,
"addressLine6": null,
"city": "Exton",
"stateCode": "PA",
"countryCode": "US",
"postalId": "1234",
"email": "janet@yahoo.com",
"phone": "787878",
"regionCode": null,
"municipalityCode": null,
"effectiveDate": null,
"expiryDate": null,
"addressSource": null,
"bankAccountNumber": null,
"costOfStamp": null,
"letterMailDate": null,
"returnMailIndicator": null,
"addressType": "Home",
"default": "False",
"phones": [{
"PhoneId": "F435C4D5-E70C-4F3A-8DE2-3C46707E8911",
"countryCode": "US",
"phoneType": "Home",
"status": "Active",
"type": null,
"callingCode": null,
"phoneNumber": "898989889",
"extension": "1234",
"preferred": "No"
}]
}],
"phones": [{
"PhoneId": "F435C4D5-E70C-4F3A-8DE2-3C46707E89A9",
"countryCode": "US",
"phoneType": "Home",
"status": "Active",
"type": null,
"callingCode": null,
"phoneNumber": "898989889",
"extension": "1234",
"preferred": "No"
},
{
"PhoneId": "F435C4D5-E70C-4F3A-8DE2-3C46707E89A9",
"countryCode": "US",
"phoneType": "Work",
"status": "Active",
"type": null,
"callingCode": null,
"phoneNumber": "898989889",
"extension": "1234",
"preferred": "Yes"
}
]
}
}